Per-database "RavenDB Studio" links in the Aspire dashboard#1444
Open
Scooletz wants to merge 6 commits into
Open
Per-database "RavenDB Studio" links in the Aspire dashboard#1444Scooletz wants to merge 6 commits into
Scooletz wants to merge 6 commits into
Conversation
Scooletz
requested review from
aviv86,
karmeli87,
ppekrol and
shiranshalom
as code owners
Contributor
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/CommunityToolkit/Aspire/main/eng/scripts/dogfood-pr.sh | bash -s -- 1444Or
iex "& { $(irm https://raw.githubusercontent.com/CommunityToolkit/Aspire/main/eng/scripts/dogfood-pr.ps1) } 1444" |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds per-database RavenDB Studio deep links to the Aspire dashboard for RavenDB database child resources, so users can jump directly into a specific database’s Documents view rather than only reaching the server.
Changes:
- Subscribes to the parent server’s endpoint allocation event and publishes a snapshot update so the dashboard renders a per-database “RavenDB Studio” URL.
- Adds unit/integration tests validating Studio URL composition and presence on the database resource.
- Documents the new dashboard behavior and exposes internals to the test assembly.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/CommunityToolkit.Aspire.Hosting.RavenDB.Tests/AppHostTests.cs | Adds an integration test asserting the per-database Studio link is present. |
| tests/CommunityToolkit.Aspire.Hosting.RavenDB.Tests/AddRavenDBTests.cs | Adds unit tests for BuildStudioUrl formatting/escaping. |
| src/CommunityToolkit.Aspire.Hosting.RavenDB/README.md | Documents the per-database Studio link behavior in the dashboard. |
| src/CommunityToolkit.Aspire.Hosting.RavenDB/RavenDBBuilderExtensions.cs | Implements Studio deep-link creation and pushes a resource snapshot URL update. |
| src/CommunityToolkit.Aspire.Hosting.RavenDB/CommunityToolkit.Aspire.Hosting.RavenDB.csproj | Grants test assembly access to internals for URL-builder testing. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #1443
Each database added via
AddDatabase(...)now shows a clickable RavenDB Studio link in the Aspire dashboard that deep-links straight into that database's Documents view, instead of only the server being reachable. The link is added automatically for every database with no extra configuration. For secured servers the link uses the configured public server URL; for unsecured ones it uses the server's allocated HTTP endpoint. The server resource itself is left unchanged. Because a database is an endpoint-less child resource (where Aspire's normalWithUrlspipeline never renders), the link is built on the parent server's endpoint-allocated event and pushed via a resource snapshot update.PR Checklist
Other information
Dogfooding
Aspire Dashboard
After clicking the link